📖 Clarify single controller assumption in OLM v1 design #2372
Conversation
Updates the design decision documentation to explicitly state that exactly one controller should exist to reconcile an object, not just "a controller". This clarifies the expected behavior and configuration
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR updates the OLM v1 design decisions documentation to clarify the controller reconciliation assumption by changing "a controller exists" to "exactly one controller exists" in the statement about user expectations for object reconciliation.
Key Changes
- Modified line 34 to state users can expect "exactly one controller exists" rather than just "a controller exists" to reconcile objects they have RBAC to create
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pedjak, rashmigottipati The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2372 +/- ##
==========================================
+ Coverage 70.61% 74.87% +4.26%
==========================================
Files 95 95
Lines 7375 7336 -39
==========================================
+ Hits 5208 5493 +285
+ Misses 1728 1409 -319
+ Partials 439 434 -5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
openshift-merge-bot
bot
merged commit d44cbaf
into
operator-framework:main
| - If an object for an API exists a controller WILL reconcile it, no matter where it is in the cluster. | ||
|
|
||
| OLM v1 will make the same assumption that Kubernetes does and that users of Kubernetes APIs do. That is: If a user has RBAC to create an object in the cluster, they can expect that a controller exists that will reconcile that object. If this assumption does not hold, it will be considered a configuration issue, not an OLM v1 bug. | ||
| OLM v1 will make the same assumption that Kubernetes does and that users of Kubernetes APIs do. That is: If a user has RBAC to create an object in the cluster, they can expect that exactly one controller exists that will reconcile that object. If this assumption does not hold, it will be considered a configuration issue, not an OLM v1 bug. |
4 participants
Description
Updates the design decision documentation to explicitly state that exactly one controller should exist to reconcile an object, not just "a controller". This clarifies the expected behavior and configuration
Reviewer Checklist